PokeKotlin API Reference

3.0.0-pre4

PokeKotlin API Reference/co.pokeapi.pokekotlin.model/PokemonForm

PokemonForm

@Serializable

data class PokemonForm(val id: Int, val name: String, val order: Int, val formOrder: Int, val isDefault: Boolean, val isBattleOnly: Boolean, val isMega: Boolean, val formName: String, val pokemon: Handle.Named<PokemonVariety>, val types: List<PokemonType>, val sprites: PokemonFormSprites, val versionGroup: Handle.Named<VersionGroup>, val names: List<Name>, val formNames: List<Name>) : NamedModel(source)

Some Pokémon may appear in one of multiple, visually different forms. These differences are purely cosmetic. For variations within a Pokémon species, which do differ in more than just visuals, the 'Pokémon' entity is used to represent such a variety. See: https://pokeapi.co/docs/v2#pokemonform

Parameters

id

The identifier for this form resource.

name

The name for this form resource.

order

The order in which forms should be sorted within all forms.

formOrder

The order in which forms should be sorted within a species' forms.

isDefault

True if this form is the default form for the Pokémon.

isBattleOnly

Whether or not this form can only happen during battle.

isMega

Whether or not this form is a mega form.

formName

The name of this form.

pokemon

The Pokémon that can take on this form.

types

The form specific type of this Pokémon form.

sprites

A set of sprites used to depict this Pokémon form in the game.

versionGroup

The version group this Pokémon form was introduced in.

names

The form specific form name of this Pokémon form, or empty if the form does not have a specific name.

formNames

The form specific form name of this Pokémon form, or empty if the form does not have a specific name.

Constructors

constructor(id: Int, name: String, order: Int, formOrder: Int, isDefault: Boolean, isBattleOnly: Boolean, isMega: Boolean, formName: String, pokemon: Handle.Named<PokemonVariety>, types: List<PokemonType>, sprites: PokemonFormSprites, versionGroup: Handle.Named<VersionGroup>, names: List<Name>, formNames: List<Name>)

Properties

val formName: String

val formNames: List<Name>

val formOrder: Int

open override val id: Int

val isBattleOnly: Boolean

val isDefault: Boolean

val isMega: Boolean

open override val name: String

val names: List<Name>

val pokemon: Handle.Named<PokemonVariety>

val sprites: PokemonFormSprites

val types: List<PokemonType>

val versionGroup: Handle.Named<VersionGroup>